home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.5 Complementary Applications 2004 February / SGI IRIX 6.5 Complementary Applications 2004 February.iso / dist / cde.idb / usr / dt / share / examples / dthelp / HelpCacheI.h.z / HelpCacheI.h
Encoding:
C/C++ Source or Header  |  2003-11-18  |  6.1 KB  |  207 lines
  1. /*
  2.  * HelpCacheI.h
  3.  *
  4.  * Copyright 2000, Silicon Graphics, Inc.
  5.  * ALL RIGHTS RESERVED
  6.  * 
  7.  * UNPUBLISHED -- Rights reserved under the copyright laws of the United
  8.  * States.   Use of a copyright notice is precautionary only and does not
  9.  * imply publication or disclosure.
  10.  *
  11.  * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
  12.  * Use, duplication or disclosure by the Government is subject to restrictions
  13.  * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
  14.  * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
  15.  * in similar or successor clauses in the FAR, or the DOD or NASA FAR
  16.  * Supplement.  Contractor/manufacturer is Silicon Graphics, Inc.,
  17.  * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
  18.  *
  19.  * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
  20.  * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
  21.  * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
  22.  * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
  23.  * GRAPHICS, INC.
  24.  */
  25. /* $XConsortium: HelpCacheI.h /main/cde1_maint/1 1995/07/17 20:59:48 drk $ */
  26. /************************************<+>*************************************
  27.  ****************************************************************************
  28.  **
  29.  **  File:        HelpCacheI.h
  30.  **
  31.  **  Project:     CDE dthelpdemo sample program.
  32.  **
  33.  **  Description: This is the header file for the HelpCache.c module.
  34.  **
  35.  **
  36.  **  (c) Copyright 1987, 1988, 1989, 1990, 1991, 1992, 1993, 1994
  37.  **      Hewlett-Packard Company
  38.  **  (c) Copyright 1993, 1994 International Business Machines Corp.
  39.  **  (c) Copyright 1993, 1994 Sun Microsystems, Inc.
  40.  **  (c) Copyright 1993, 1994 Unix System Labs, Inc., a subsidiary of
  41.  **      Novell, Inc.
  42.  **
  43.  ****************************************************************************
  44.  ************************************<+>*************************************/
  45.  
  46. #ifndef _HelpCacheI_h
  47. #define _HelpCacheI_h
  48.  
  49.  
  50.  
  51. /****************************************************************
  52.  *
  53.  *  Cache List Info Structure Definition.
  54.  *
  55.  ****************************************************************/
  56. typedef struct _CacheListStruct {
  57.     Widget                    helpDialog;
  58.     Boolean                   inUseFlag;
  59.     struct _CacheListStruct   *pNext;
  60.     struct _CacheListStruct   *pPrevious;
  61. } CacheListStruct;
  62.  
  63.  
  64.  
  65. /****************************************************************************
  66.  * Function:        void DisplayTopic(
  67.  *                              Widget parent,
  68.  *                              char *accessPath,
  69.  *                              char *idString)
  70.  *
  71.  *
  72.  * Return Value:    Void.
  73.  *
  74.  * Purpose:         Creats and displays a new help dialog w/the requested help
  75.  *                  volume and topic.
  76.  *
  77.  ****************************************************************************/
  78. extern void DisplayTopic(
  79.     Widget  parent,
  80.     char    *helpVolume,
  81.     char    *locationId);
  82.  
  83.  
  84.  
  85.  
  86. /****************************************************************************
  87.  * Function:        void DisplayMain(
  88.  *                              Widget parent,
  89.  *                              char *helpVolume,
  90.  *                              char *locationId)
  91.  *
  92.  *
  93.  * Return Value:    Void.
  94.  *
  95.  * Purpose:         Displays help for helpdemo in the one helpDialog window 
  96.  *                  created for the applicaiton.
  97.  *
  98.  ****************************************************************************/
  99. extern void DisplayMain( 
  100.     Widget  parent,
  101.     char    *helpVolume,
  102.     char    *locationId);
  103.  
  104.  
  105.  
  106. /****************************************************************************
  107.  * Function:        void DisplayVersion(
  108.  *                              Widget parent,
  109.  *                              char *helpVolume,
  110.  *                              char *locationId)
  111.  *
  112.  * Return Value:    Void.
  113.  *
  114.  * Purpose:         Displays the version dialog for the helpdemo program.
  115.  *
  116.  ****************************************************************************/
  117. extern void DisplayVersion( 
  118.     Widget  parent,
  119.     char    *helpVolume,
  120.     char    *locationId);
  121.  
  122.  
  123.  
  124. /*****************************************************************************
  125.  * Function:        void HelpMapCB()
  126.  *                   
  127.  *                            
  128.  *
  129.  * Parameters:      client_data is the widget in reference to
  130.  *                  which widget w is placed
  131.  *
  132.  * Return Value:    Void.
  133.  *
  134.  * Purpose:         Determins where a new child dialog should be mapped in
  135.  *                  relation to its parent.
  136.  *
  137.  * Algorithm:       1. attempt left or right placement with no overlap
  138.  *                  2. if fails, attempt up or down placement with no overlap
  139.  *                  3. if fails, determines location with least
  140.  *                     amount of overlap, and places there.
  141.  *
  142.  *****************************************************************************/
  143. extern XtCallbackProc HelpMapCB(
  144.     Widget w,
  145.     XtPointer clientData,
  146.     XtPointer callData);
  147.  
  148.  
  149.  
  150. /****************************************************************************
  151.  * Function:        void DisplayMan()
  152.  *
  153.  * Parameters:      
  154.  *
  155.  * Return Value:    Void.
  156.  *
  157.  * Purpose:         Displays a UNIX man page in a quick help dialog.
  158.  *
  159.  ****************************************************************************/
  160. extern void DisplayMan(
  161.     Widget  parent,
  162.     char    *man);
  163.  
  164.  
  165.  
  166. /****************************************************************************
  167.  * Function:        void ProcessLinkCB(
  168.  *                              Widget w,
  169.  *                              XtPointer  clientData, 
  170.  *                          XtPointer callData
  171.  *
  172.  * Parameters:      
  173.  *
  174.  * Return Value:    Void.
  175.  *
  176.  * Purpose:         Process JUMP-NEW and APP-LINK hypertext requests in a 
  177.  *                  given Help Dialog Window.
  178.  *                 
  179.  *                  This is the callback used for the DtNhyperLinkCallback
  180.  *                  on each of the help dialog widges created.
  181.  *
  182.  ****************************************************************************/
  183. extern void ProcessLinkCB (
  184.     Widget w,
  185.     XtPointer clientData,
  186.     XtPointer callData);
  187.  
  188.  
  189. #endif /* _HelpCacheI_h */
  190. /* DON'T ADD ANYTHING AFTER THIS #endif */
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.  
  206.  
  207.